Add declarative custom-engine frontmatter and migrate Crush/OpenCode to shared behavior definitions by Copilot · Pull Request #44465 · github/gh-aw

Copilot · 2026-07-09T04:17:55Z

This introduces a richer engine-definition frontmatter shape for shared/custom agentic engines and uses it to move Crush and OpenCode off bespoke Go implementations onto a common declarative runtime path. The new syntax is expressive enough for CLI-style engines that need install, config, execution, MCP, capability, and auth wiring, including Auggie-like cases.

New engine-definition surface
- Adds engine.experimental, engine.auth, and engine.behaviors to the named engine definition form.
- behaviors captures the runtime contract instead of hard-coding it in Go:
  - capabilities
  - manifest files/path prefixes
  - installation metadata
  - config file generation
  - execution command/args/env
  - MCP config target
- auth provides explicit secret bindings for engines that need engine-specific credentials forwarded into the runtime.
Shared behavior-defined runtime
- Adds a generic BehaviorDefinedEngine that materializes a CodingAgentEngine from frontmatter.
- Reuses the existing universal provider/model routing where applicable, but also supports engine-specific secret/env bindings for nonstandard CLIs.
- Registers imported named engine definitions during compilation so shared workflows can define engines declaratively instead of requiring Go registration.
Crush/OpenCode refactor
- Replaces the bespoke Crush/OpenCode runtime logic with thin wrappers over builtin engine definitions.
- Moves engine-specific behavior into:
  - pkg/workflow/data/engines/crush.md
  - pkg/workflow/data/engines/opencode.md
- Keeps their existing runtime identity while making their install/config/execute behavior data-driven.
Schema and docs
- Extends the workflow schema and frontmatter reference docs to describe the new engine-definition fields.
- Documents the custom-engine shape with behavior blocks and auth bindings so new engines can be added without copy-pasting a dedicated Go implementation.
Coverage
- Adds/updates tests for:
  - schema shape
  - builtin engine definitions
  - imported behavior-defined engines
  - Crush/OpenCode parity through the shared path
- Includes an imported Auggie-style engine example to exercise explicit auth binding and declarative execution.

Example of the new shared engine definition shape:

engine:
  id: auggie
  display-name: Auggie
  experimental: true
  auth:
    - role: session
      secret: AUGMENT_SESSION_AUTH
  behaviors:
    supported-env-var-keys:
      - AUGMENT_SESSION_AUTH
    installation:
      package-manager: npm
      package-name: "@augmentcode/auggie"
      version: "1.0.0"
      step-name: Install Auggie
      binary-name: auggie
      include-node-setup: true
    config-file:
      path: .auggie.json
      step-name: Write Auggie Config
      content: '{"sandbox":"workspace-write"}'
      merge-strategy: json-merge
    execution:
      command-name: auggie
      args: [run]
      step-name: Execute Auggie CLI
      model-env-var: AUGGIE_MODEL
      mcp-config-env-var: AUGGIE_MCP_CONFIG
      write-timestamp: true

Generated by 👨‍🍳 PR Sous Chef · 10.4 AIC · ⌖ 5.15 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 16.6 AIC · ⌖ 7.21 AIC · ⊞ 4.7K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 8.9 AIC · ⌖ 5.99 AIC · ⊞ 4.7K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 6.57 AIC · ⌖ 6.74 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 4.36 AIC · ⌖ 7.98 AIC · ⊞ 4.7K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 7.94 AIC · ⌖ 6.73 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 9.71 AIC · ⌖ 6.72 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 12.5 AIC · ⌖ 6.14 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 4.34 AIC · ⌖ 5.93 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 11.3 AIC · ⌖ 6.23 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 10.4 AIC · ⌖ 4.23 AIC · ⊞ 7.1K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 11.7 AIC · ⌖ 6.78 AIC · ⊞ 4.2K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 4.72 AIC · ⌖ 6.03 AIC · ⊞ 7.5K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 6.21 AIC · ⌖ 8.01 AIC · ⊞ 7.5K · ◷
_{Comment /souschef to run again}

Generated by 👨‍🍳 PR Sous Chef · 9.13 AIC · ⌖ 8 AIC · ⊞ 5.1K · ◷
_{Comment /souschef to run again}

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2026-07-09T04:26:28Z

@copilot remove crush/opencode from Go code and only keep them as shared agentic workflow files.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan · 2026-07-09T04:42:35Z

@copilot create a new instruction file to help with configuring new agentic engines

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-09T04:50:34Z

@copilot remove crush/opencode from Go code and only keep them as shared agentic workflow files.

Addressed in 5537932.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-09T05:07:33Z

@copilot create a new instruction file to help with configuring new agentic engines

Addressed in ab02806.

pelikhan · 2026-07-09T05:14:37Z

@copilot merge main and recompile
Run pr-finisher skill

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…c-engine-syntax Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-09T05:40:47Z

@copilot merge main and recompile
Run pr-finisher skill

Addressed in 1610bec.

pelikhan · 2026-07-13T21:20:23Z

/smoke-opencode

github-actions · 2026-07-13T21:20:51Z

⚠️ Smoke OpenCode failed. OpenCode encountered unexpected challenges...

gh-aw-bot · 2026-07-13T21:36:12Z

pr-sous-chef
@copilot please run the pr-finisher skill, address any remaining review feedback, and rerun checks once the branch is up to date.

Run: https://github.com/github/gh-aw/actions/runs/29286484887

Generated by 👨‍🍳 PR Sous Chef · 9.66 AIC · ⌖ 6.15 AIC · ⊞ 5.1K · ◷
_{Comment /souschef to run again}

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

…c-engine-syntax Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

…xy provider The custom `awf-proxy` provider used a placeholder API key `awf-copilot-proxy` that only works when requests are routed through the AWF api-proxy container at 172.30.0.30:10002. However, `host.docker.internal:10002` resolves to the Docker host's LLM gateway (not the api-proxy container), which requires a real Copilot token and rejects the placeholder with HTTP 503. Fix: remove the custom `awf-proxy` provider from opencode.jsonc and remove the `model-env-provider-prefix: awf-proxy` rewrite. OpenCode's built-in `copilot` provider with `GITHUB_COPILOT_BASE_URL` and `OPENAI_API_KEY` env vars (already injected by universal-llm-consumer) works correctly against host.docker.internal:10002. Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

Copilot · 2026-07-13T22:04:30Z

pr-sous-chef
@copilot please run the pr-finisher skill, address any remaining review feedback, and rerun checks once the branch is up to date.
...

Fixed in commit c5f4d10 (merged main + fix in 9d06555/c5f4d10).

Root cause of HTTP 503:

The OpenCode engine config defined a custom awf-proxy provider with a placeholder API key awf-copilot-proxy:

"awf-proxy": {
  "api": "http://host.docker.internal:10002/v1",
  "options": { "apiKey": "awf-copilot-proxy" },
  "models": { "gpt-5.5": {} }
}

This placeholder is designed to be replaced by the AWF api-proxy container (172.30.0.30:10002). But host.docker.internal:10002 resolves to the Docker host machine's LLM gateway, which requires a real Copilot token — not the placeholder — and returns 503.

Fix:

Removed the custom awf-proxy provider block from opencode.jsonc
Removed model-env-provider-prefix: awf-proxy (so OPENCODE_MODEL: copilot/gpt-5.5 passes through as-is)
OpenCode now uses its built-in copilot provider with GITHUB_COPILOT_BASE_URL: http://host.docker.internal:10002 and OPENAI_API_KEY: ${{ secrets.COPILOT_GITHUB_TOKEN }} — already injected by the universal-llm-consumer path — which is exactly what the original pre-refactor implementation did

Local validation: make test-unit, make agent-report-progress — 257/257 workflows compiled, 0 errors, lock files in sync.

Needs a maintainer /smoke-opencode to confirm green on HEAD c5f4d10.

gh-aw-bot · 2026-07-14T02:21:57Z

pr-sous-chef
@copilot please run the pr-finisher skill, ensure the branch is up to date, address any remaining review feedback, and rerun checks.

Run: https://github.com/github/gh-aw/actions/runs/29300559914

Generated by 👨‍🍳 PR Sous Chef · 6.11 AIC · ⌖ 20.2 AIC · ⊞ 7.5K · ◷
_{Comment /souschef to run again}

pelikhan · 2026-07-14T02:31:33Z

/smoke-opencode

github-actions · 2026-07-14T02:32:28Z

🚀 Smoke OpenCode MISSION COMPLETE! OpenCode delivered. 🔥

Copilot · 2026-07-14T02:38:52Z

pr-sous-chef
@copilot please run the pr-finisher skill, ensure the branch is up to date, address any remaining review feedback, and rerun checks.
...

✅ Reviews — All 4 review threads are resolved (AWF exclude-env secret handling, required secret propagation, MCP config env wiring, config-file parent-directory creation).
✅ Checks (local) — make fmt, make lint, make test-unit, make agent-report-progress all pass. 257/257 workflows compiled, 0 errors, lock files in sync.
❓ Checks (CI) — Stale after last agent push (c5f4d10). The latest Smoke OpenCode run (29285992583 on 29efc4c) failed with a 10-minute timeout on the "Execute OpenCode CLI" step — root cause: providerID=awf-proxy was still in play on that commit. That was fixed in c5f4d10 (removed the custom awf-proxy provider block from opencode.jsonc; OpenCode now uses its built-in copilot provider with GITHUB_COPILOT_BASE_URL and standard env injection). All other CI runs are action_required (pending maintainer approval, not code failures).
✅ Mergeable — Branch is up to date with main (0 commits behind, head c5f4d10), no conflicts.

Actions taken: none — working tree is clean, all previous fixes are in place.

Hand-off: A maintainer needs to /smoke-opencode on the current HEAD (c5f4d10) to confirm green before merge.

pelikhan · 2026-07-14T02:43:33Z

@copilot OpenCode is misconfigured https://github.com/github/gh-aw/actions/runs/29301322952/job/86985617751#step:28:1

…er with internal IP Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…172.30.0.30:10002) OpenCode v1.2.14 uses @ai-sdk/openai@3.x for built-in providers (copilot, openai), which always routes to the OpenAI Responses API (/v1/responses). The AWF proxy only supports /v1/chat/completions, so every request fails with HTTP 503. The fix is to use a custom provider name ("awf-proxy") which causes OpenCode to fall back to @ai-sdk/openai-compatible, which ONLY uses Chat Completions API. Previous fix (c5f4d10) used http://host.docker.internal:10002 as the api URL, but from inside the AWF container this resolves to the Docker host machine's LLM gateway which requires a real Copilot token and rejects the placeholder key. Correct fix: use http://172.30.0.30:10002/v1 (constants.AWFAPIProxyContainerIP) which is the internal Docker network address of the AWF api-proxy sidecar. This endpoint accepts the awf-copilot-proxy placeholder key because the proxy handles token steering internally. Also adds 172.30.0.30 and 172.30.0.30:PORT entries to AWFNoProxyHosts so that Bun (which backs OpenCode) bypasses Squid when making requests to the internal api-proxy. Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-14T03:15:32Z

@copilot OpenCode is misconfigured https://github.com/github/gh-aw/actions/runs/29301322952/job/86985617751#step:28:1

Fixed in commit ddf530c.

Root cause: OpenCode v1.2.14 uses @ai-sdk/openai@3.x for its built-in providers (copilot, openai). That SDK's sdk.responses(modelID) always routes to /v1/responses (OpenAI Responses API), which the AWF api-proxy does not support — it only handles /v1/chat/completions. This causes every request to fail.

Why the previous fix (c5f4d10) also failed: It switched back to the built-in copilot provider, which still routes to /v1/responses. Same failure mode, different path.

Actual fix (restored approach with correct IP):

Custom awf-proxy provider — OpenCode treats any provider name not in its models.dev database as an "openai-compatible" provider, which uses @ai-sdk/openai-compatible → Chat Completions API only. This is what we need.
Correct API URL: http://172.30.0.30:10002/v1 — The AWFAPIProxyContainerIP (172.30.0.30) is the fixed internal Docker network IP of the AWF api-proxy sidecar. The previous attempt used host.docker.internal:10002, which from inside the AWF container resolves to the Docker host machine's LLM gateway — which requires a real token and returns 503. The internal sidecar at 172.30.0.30 accepts the awf-copilot-proxy placeholder key and steers the token internally.
Added 172.30.0.30 to AWFNoProxyHosts — Bun (OpenCode's HTTP runtime) compares the full host:port string against NO_PROXY, so both 172.30.0.30 and 172.30.0.30:10002 are explicitly listed to bypass Squid.

A maintainer /smoke-opencode is needed to verify the fix in CI.

pelikhan · 2026-07-14T03:17:27Z

/smoke-opencode

github-actions · 2026-07-14T03:17:56Z

🚀 Smoke OpenCode MISSION COMPLETE! OpenCode delivered. 🔥

pelikhan · 2026-07-14T04:06:36Z

@copilot error with connection https://github.com/github/gh-aw/actions/runs/29303183562/job/86991186603#step:28:1

…ions Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

…int is /chat/completions not /v1/chat/completions) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-14T04:38:07Z

@copilot error with connection https://github.com/github/gh-aw/actions/runs/29303183562/job/86991186603#step:28:1

Fixed in commit fix: remove /v1 suffix from OpenCode awf-proxy API URL.

Root cause: The AWF api-proxy sidecar at port 10002 serves the Copilot API format, which uses /chat/completions (no /v1 prefix). The opencode.md config had "api": "http://172.30.0.30:10002/v1", causing @ai-sdk/openai-compatible to append /chat/completions and call http://172.30.0.30:10002/v1/chat/completions → 404.

Fix: Changed to "api": "http://172.30.0.30:10002" so the SDK calls http://172.30.0.30:10002/chat/completions, matching the Copilot API endpoint format.

Please /smoke-opencode to verify.

pelikhan · 2026-07-14T06:57:51Z

/smoke-opencode

github-actions · 2026-07-14T06:58:17Z

🚀 Smoke OpenCode MISSION COMPLETE! OpenCode delivered. 🔥

pelikhan · 2026-07-14T07:18:05Z

@copilot pick an older model compatible with completions

https://github.com/github/gh-aw/actions/runs/29313009110/job/87020905713#step:28:1

…atibility Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot · 2026-07-14T07:38:02Z

@copilot pick an older model compatible with completions

https://github.com/github/gh-aw/actions/runs/29313009110/job/87020905713#step:28:1

Switched to gpt-4.1 in both smoke-opencode.md and the awf-proxy provider models in opencode.md. gpt-5.5 uses OpenAI's Responses API (/v1/responses) which the AWF api-proxy doesn't support — gpt-4.1 routes via chat completions as expected.

Fixed in commit fix: use gpt-4.1 for OpenCode smoke test (chat completions compatible).

Copilot AI and others added 3 commits July 9, 2026 03:49

chore: start custom engine frontmatter work

bdcddb4

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

feat: add declarative behavior-defined engines

6d21dc9

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

test: stabilize declarative engine coverage

4acfe84

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI assigned Copilot and pelikhan Jul 9, 2026

Copilot AI changed the title ~~Add declarative frontmatter syntax for custom agentic engines~~ Add declarative custom-engine frontmatter and migrate Crush/OpenCode to shared behavior definitions Jul 9, 2026

Copilot AI requested a review from pelikhan July 9, 2026 04:18

Copilot created this pull request from a session on behalf of pelikhan July 9, 2026 04:18 View session

Copilot finished work on behalf of pelikhan July 9, 2026 04:18

Copilot started work on behalf of pelikhan July 9, 2026 04:27 View session

Plan follow-up engine cleanup

b287591

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

pelikhan mentioned this pull request Jul 9, 2026

Add Augment Code "Auggie" CLI as a new agentic engine #42199

Open

Remove Crush/OpenCode Go wrappers

5537932

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan July 9, 2026 04:51

Copilot started work on behalf of pelikhan July 9, 2026 04:52 View session

Add engine configuration instruction file

ab02806

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan July 9, 2026 05:08

Copilot started work on behalf of pelikhan July 9, 2026 05:15 View session

Copilot AI and others added 3 commits July 9, 2026 05:20

Plan merge main and recompile

68d3e3b

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into copilot/define-agenti…

daf5e1d

…c-engine-syntax Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Merge main and recompile

1610bec

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot finished work on behalf of pelikhan July 9, 2026 05:41

github-actions Bot added pr-action:defer pr-agent:copilot-swe-agent labels Jul 9, 2026

Copilot AI and others added 3 commits July 13, 2026 21:50

wip: start opencode provider fix

cf02f88

Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into copilot/define-agenti…

9d06555

…c-engine-syntax Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>

github-actions Bot mentioned this pull request Jul 14, 2026

[pr-sous-chef] Run report — 4 nudged, 3 skipped #45345

Open

github-actions Bot mentioned this pull request Jul 14, 2026

[aw] Smoke OpenCode produced no safe outputs #45358

Closed

Copilot AI and others added 2 commits July 14, 2026 02:59

plan: fix OpenCode misconfiguration — restore awf-proxy custom provid…

e87027f

…er with internal IP Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

github-actions Bot mentioned this pull request Jul 14, 2026

[aw] Smoke OpenCode produced no safe outputs #45366

Open

Copilot AI and others added 2 commits July 14, 2026 04:17

plan: investigate OpenCode connection error - 404 at /v1/chat/complet…

a6f13e1

…ions Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

fix: remove /v1 suffix from OpenCode awf-proxy API URL (Copilot endpo…

8ca7b9e

…int is /chat/completions not /v1/chat/completions) Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Copilot AI and others added 2 commits July 14, 2026 07:26

plan: switch OpenCode smoke test to gpt-4.1 for chat completions comp…

2039948

…atibility Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

fix: use gpt-4.1 for OpenCode smoke test (chat completions compatible)

5883940

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>

Uh oh!

Conversation

Copilot AI commented Jul 9, 2026 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelikhan commented Jul 9, 2026

Uh oh!

pelikhan commented Jul 9, 2026

Uh oh!

Copilot AI commented Jul 9, 2026

Uh oh!

Copilot AI commented Jul 9, 2026

Uh oh!

pelikhan commented Jul 9, 2026

Uh oh!

Copilot AI commented Jul 9, 2026

Uh oh!

pelikhan commented Jul 13, 2026

Uh oh!

github-actions Bot commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gh-aw-bot commented Jul 13, 2026

Uh oh!

Copilot AI commented Jul 13, 2026

Uh oh!

gh-aw-bot commented Jul 14, 2026

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

github-actions Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI commented Jul 14, 2026

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

Copilot AI commented Jul 14, 2026

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

github-actions Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

Copilot AI commented Jul 14, 2026

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

github-actions Bot commented Jul 14, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pelikhan commented Jul 14, 2026

Uh oh!

Copilot AI commented Jul 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jul 9, 2026 •

edited by github-actions Bot

Loading

github-actions Bot commented Jul 13, 2026 •

edited

Loading

github-actions Bot commented Jul 14, 2026 •

edited

Loading

github-actions Bot commented Jul 14, 2026 •

edited

Loading

github-actions Bot commented Jul 14, 2026 •

edited

Loading